// 
// Copyright(c) 2009 Syntext, Inc. All Rights Reserved.
// Contact: info@syntext.com, http://www.syntext.com
// 
// This file is part of Syntext Serna XML Editor.
// 
// COMMERCIAL USAGE
// Licensees holding valid Syntext Serna commercial licenses may use this file
// in accordance with the Syntext Serna Commercial License Agreement provided
// with the software, or, alternatively, in accorance with the terms contained
// in a written agreement between you and Syntext, Inc.
// 
// GNU GENERAL PUBLIC LICENSE USAGE
// Alternatively, this file may be used under the terms of the GNU General 
// Public License versions 2.0 or 3.0 as published by the Free Software 
// Foundation and appearing in the file LICENSE.GPL included in the packaging 
// of this file. In addition, as a special exception, Syntext, Inc. gives you
// certain additional rights, which are described in the Syntext, Inc. GPL 
// Exception for Syntext Serna Free Edition, included in the file 
// GPL_EXCEPTION.txt in this package.
// 
// You should have received a copy of appropriate licenses along with this 
// package. If not, see <http://www.syntext.com/legal/>. If you are unsure
// which license is appropriate for your use, please contact the sales 
// department at sales@syntext.com.
// 
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
// 
#ifndef DOCVIEW_INSERT_SYMBOL_H_
#define DOCVIEW_INSERT_SYMBOL_H_

//#include "ui/UiItem.h"
#include "ui/LiquidItem.h"

#include "docview/dv_defs.h"

#include "common/CommandEvent.h"
#include "common/OwnerPtr.h"
#include "common/PropertyTree.h"

#include "utils/SernaUiItems.h"


namespace InsertSymbolSpace
{
DOCVIEW_EXPIMP extern const char* const SYMBOL;
}

class DOCVIEW_EXPIMP InsertSymbolItem : public Common::CommandEventContext,
                                        public Sui::LiquidItem {
public:
    InsertSymbolItem(PropertyNode* properties);
    virtual ~InsertSymbolItem();

    static InsertSymbolItem* findInstance(const Sui::Item* from);

    virtual String       itemClass() const { return Sui::INSERT_SYMBOL; }

    bool                 insert();

protected:
    virtual bool         doInsert() = 0;
    virtual int          toolDockMask() const { return UNDOCKED_TOOL; }

    QWidget*             makeWidget(QWidget* parent, Type type);

    virtual const char*  selfTypeId() const
    {
        return typeid(InsertSymbolItem).name();
    }
};

#endif // DOCVIEW_INSERT_SYMBOL_H_
